You can configure details of File Systems in Pyramid for use as Primary File Storage. Setting up multiple locations allows your administrator to switch File Servers easily.
Note: This feature is only available with the Enterprise Edition license.
File System page
Managing File Systems
- Add a File System: Click Plus (+) at the top-right of the File System list to capture details of a new file system. When you click the button, the Edit File System panel opens at the bottom of the page. You need to specify a Caption (name), select a Permanent Storage Type, and then complete the file system details. The fields shown in this panel depend on your Permanent Storage Type.
- Edit an Existing File System: Click Edit in the Actions column to open the Edit File System panel with the details of the selected file system in it. Edit the details as required.
- Delete an Existing File System: Click Delete in the Actions column to delete a file system. You cannot delete a file that is currently in use.
Permanent Storage Type
Which fields you need to complete, depends on the selected Permanent Storage type. You must supply the following common details as required:
- Caption: This is the name of your server and will be used to select this file system elsewhere in Pyramid.
- Description: Optional text description.
- Secure by Tenant: Do not select this option if your file server is intended for use as Primary File Storage.
Many of the masked fields (keys and passwords) incorporate a Show/Hide icon, allowing you to view clear text versions of masked values:
Internal File System
The Internal File System is the default system created by the installation process. Where this is selected as the Primary File Storage, temporary and persistent content is stored on the designated data drives for each server.
Azure Blob
Where this is selected, all persistent files are stored on Azure Blob storage.
- Storage Account Name: The name for your storage account with Microsoft Azure.
- Storage Account Key: The account key used to connect to the account.
- Container: Once you have entered your account name and key, click refresh to populate the drop-down and then select the container name.
- Folder: Once you have selected your container, click refresh to populate the drop-down and select the folder name or
/.
Amazon S3
Where this is selected, all persistent files are stored on AWS S3 Bucket storage.
- AWS Access Key ID: AWS Access Key ID. To use an AWS IAM role, type
"iam"into this field after configuring a role on AWS. In this case, you do not need to set an AWS Secret Access key. - AWS Secret Access key: AWS Secret Access key.
- Region ID: AWS Region Code. A full list can be found here.
- Bucket: Once the previous details are correct, click refresh to populate the drop-down and then select the bucket name.
- Folder: Once the previous details are correct, click refresh to populate the drop-down and select the folder name or
/.
FTP
Where this is selected, all persistent files are stored on an FTP file system.
- Hostname: FTP server address.
- Port: FTP server port.
- User Name: FTP server username.
- Password: FTP server password.
- Encryption: Select FTP encryption option.
- Mode: Select Active or Passive mode.
- Folder: Once the previous details are correct, click refresh to populate the drop-down and select the folder name or
/.
SSH/SFTP
Where this is selected, all persistent files are stored on an SSH/SFTP file system.
- Hostname: SSH/SFTP server address.
- Port: SSH/SFTP server port.
- User Name: SSH/SFTP server username.
- Password: SSH/SFTP server password.
- Folder: Once the previous details are correct, click refresh to populate the drop-down and select the folder name or
/.
Shared Folder/Local Path
Where this is selected, all persistent files are stored on the specified shared folder or directory.
Use of a shared folder differs between Windows and Linux. In both scenarios, the shared folder needs to be IDENTICALLY deployed to each server in the cluster, pointing to a common shared resource.
Windows
- Folder: supply the UNC path to a shared folder
To create the shared folder in Windows, the UNC path needs to be the same on all servers. It can also be created with a net use command that adds a virtual drive to each Windows machine with the following command:
net use Z: \\server\folder /user:domain\myusername mypassword /persistent:yes
Linux
- Folder: supply the local path that is linked to a shared mounted drive
To create the shared folder in Linux, mount a folder from a server to a local folder on all servers in the cluster. This can be done with the following command:
sudo mount -t nfs servername:/sharedfolder /mnt/shared
Test Changes
To check the connection, click Test before committing your changes. This test writes, reads, and deletes a file on the file system.